Skip to content

Implement changes defined in ADR034 and 035 - #393

Open
NotTheEvilOne wants to merge 2 commits into
mainfrom
feature/adr34
Open

Implement changes defined in ADR034 and 035#393
NotTheEvilOne wants to merge 2 commits into
mainfrom
feature/adr34

Conversation

@NotTheEvilOne

@NotTheEvilOne NotTheEvilOne commented Sep 17, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

What this PR does / why we need it:
This PR implements changes required to suit ADR034 and 035.

Main changes

  • Implementation of ADR 034 and 035. This requires renaming and introducing inherited classes for Flavor, VersionedFlavor and ArtifactBaseName in gardenlinux.features`.
  • Fixing sorting of feature lists for flavors.yaml parser in gardenlinux.flavors.Parser
  • Changes to various classes utilizing gardenlinux.features
  • Implement changed naming to gl-features-parse and remove shortcut command line tool gl-cname.

Which issue(s) this PR fixes:
Fixes #376
Fixes #377
Requires #390

@NotTheEvilOne
NotTheEvilOne force-pushed the feature/adr34 branch 4 times, most recently from 82428ae to 0efc342 Compare September 18, 2026 12:06
@codecov

codecov Bot commented Sep 18, 2026 •
edited
Loading

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 90.23355% with 46 lines in your changes missing coverage. Please review.
✅ Project coverage is 91.77%. Comparing base (acc50b5) to head (3871196).
⚠️ Report is 17 commits behind head on main.

Files with missing lines Patch % Lines
src/gardenlinux/features/artifact_base_name.py 86.98% 19 Missing ⚠️
src/gardenlinux/features/__main__.py 82.55% 15 Missing ⚠️
src/gardenlinux/features/c_name.py 94.18% 5 Missing ⚠️
src/gardenlinux/oci/container.py 66.66% 4 Missing ⚠️
src/gardenlinux/features/parser.py 88.88% 2 Missing ⚠️
src/gardenlinux/oci/image_manifest.py 90.00% 1 Missing ⚠️
Additional details and impacted files 
@@            Coverage Diff             @@
##             main     #393      +/-   ##
==========================================
+ Coverage   91.28%   91.77%   +0.49%     
==========================================
  Files          49       51       +2     
  Lines        2971     3004      +33     
==========================================
+ Hits         2712     2757      +45     
+ Misses        259      247      -12

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@NotTheEvilOne
NotTheEvilOne force-pushed the feature/adr34 branch 16 times, most recently from 62064c1 to bfd41fc Compare September 29, 2026 08:24
@NotTheEvilOne
NotTheEvilOne requested a review from a team September 29, 2026 08:46
@NotTheEvilOne NotTheEvilOne self-assigned this Sep 29, 2026
@NotTheEvilOne
NotTheEvilOne marked this pull request as ready for review September 29, 2026 08:46
This was referenced Sep 29, 2026
Open
Open
@NotTheEvilOne
Remove no longer used GitHub actions
b4d51db 
Signed-off-by: Tobias Wolf <wolf@b1-systems.de>
On-behalf-of: SAP <tobias.wolf@sap.com>
@NotTheEvilOne
NotTheEvilOne force-pushed the feature/adr34 branch 3 times, most recently from d8d08bd to 3871196 Compare September 29, 2026 10:36
@gardenlinux-docs-bot

gardenlinux-docs-bot Bot commented Sep 29, 2026

Copy link
Copy Markdown

📚 Documentation Preview PR: gardenlinux/docs#184
😎 Deploy Preview: https://deploy-preview-184--gardenlinux-docs.netlify.app

A PR has been created/updated to preview the documentation changes from this PR.

@gardenlinux-docs-bot gardenlinux-docs-bot Bot mentioned this pull request Sep 29, 2026
Draft
@NotTheEvilOne
Implement changes for ADR034 and 035.
b1d55ca 
Signed-off-by: Tobias Wolf <wolf@b1-systems.de>
On-behalf-of: <tobias.wolf@sap.com>
yeoldegrove
yeoldegrove requested changes Sep 30, 2026
View reviewed changes

@yeoldegrove yeoldegrove left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added some comments in the code.

Also please justify in the PR description or fix:

  1. GL_ALLOW_FRANKENSTEIN and GL_ALLOW_MULTIPLE_PLATFORMS env vars are still evaluated and GARDENLINUX_PLATFORM from /etc/os-release (created by builder) is not taken into account. This is different as outlined in #376.
  2. CName.platform still exists (related to 1.) but should be reworked as outlined in #377.

Comment thread src/gardenlinux/oci/image_manifest.py
Comment on lines +174 to +176
cname, arch = value.rsplit("-", 1)
self["annotations"][ImageManifest.ANNOTATION_ARCH_KEY] = arch
self["annotations"][ImageManifest.ANNOTATION_CNAME_KEY] = cname

@yeoldegrove yeoldegrove Sep 30, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would it make sense to validate cname and arch?

@NotTheEvilOne NotTheEvilOne Sep 30, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Validation could be implemented but would only contain basic formatting validation as we can not hard code a list of architectures or validate the content of the feature list of a CName.

Comment thread src/gardenlinux/features/parser.py
else:
features.append(feature)

return reduce(

@yeoldegrove yeoldegrove Sep 30, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does it make sense to use sort_graph_nodes here?

@NotTheEvilOne NotTheEvilOne Sep 30, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unfortunately we would need a graph for using sort_graph_nodes. get_cname_from_feature_set() and get_cname_as_feature_set() accept input from e.g. the os_release file fields without evaluating if the given feature set is plausible. Therefore this sorting can only work with data available.

@NotTheEvilOne

NotTheEvilOne commented Sep 30, 2026

Copy link
Copy Markdown
Contributor Author

Added some comments in the code.

Also please justify in the PR description or fix:

1. `GL_ALLOW_FRANKENSTEIN` and `GL_ALLOW_MULTIPLE_PLATFORMS` env vars are still evaluated and `GARDENLINUX_PLATFORM` from `/etc/os-release` (created by builder) is not taken into account. This is different as outlined in #376.

2. `CName.platform` still exists (related to 1.) but should be reworked as outlined in #377.

Thanks for taking your time reviewing. Regarding platform this field is intended in addition to platform_variant to be visible first class citizens of the CName class. Beside the availability of the property feature_set_platform it reflects the os_release key GARDENLINUX_PLATFORM instead of GARDENLINUX_FEATURES_PLATFORMS. As we accept input from os_release without parsing the features tree if cached both properties exist.

As the alternative to the enviromment variables an command line argument --allow-frakenstein would be needed that needs to be reevaluated in different code paths (like within gardenlinux.features.CName and __main__.py) this implementation specific behaviour has not been changed. python-gardenlinux-lib can be extended and reused in other Python projects while the builder is a standalone application. This causes implementation details to be adjusted based on intended usage.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@yeoldegrove yeoldegrove yeoldegrove requested changes

Requested changes must be addressed to merge this pull request.

Assignees

@NotTheEvilOne NotTheEvilOne

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Align cname and flavor handling with ADR 0035 Align platform resolution with ADR 0034

2 participants

@NotTheEvilOne @yeoldegrove